/**
 * @addtogroup IniReadStr
 * IniReadStr
 * @{
 */
/**
 * @file        IniReadStr.h
 * @brief       XXXX
 * @note        XXXX
 * @author      靳普诏(puzhao.jin@hopechart.com)
 * @date        2023/11/11
 * @version     1.0

 * @par         修改日志
 * <table>
 * <tr><th>Date         <th>Version     <th>Author      <th> Description
 * <tr><td>2023/11/11   <td>1.0         <td>靳普诏       <td> 创建初始版本
 * @copyright 杭州鸿泉物联网技术股份有限公司
 */

#ifndef _INIREADSTR_H_
#define _INIREADSTR_H_

#include "ofc_types.h"



#ifdef __cplusplus
extern "C"
{
#endif

/**
 * @brief 去掉字符串左右空白字符, 检查内部没有换行
 * @param str 字符串头地址，传出有效位首地址
 * @param end 传出有效位结束地址
 * @return int 有效长度
 */
Bool CheckString(PChar *str, PChar *end);

/*--------------------------------------------------------------------*/

/**
 * @brief 读取INI文件键值
 * @param fname     文件名
 * @param section   节名
 * @param key       键名
 * @param value     存放结果的缓存区；为NULL时 只返回键值长度
 * @param size      缓存区尺寸
 * @return int      参数错误-4；键名不存在-3；节名不存在-2；文件打开失败-1；成功返回键值长度
 */
int IniReadStr(const char *fname, const char *section, const char *key, char *value, int size);


#ifdef __cplusplus
}  ///< extern "C"
#endif

#endif  ///< _INIREADSTR_H_

/**
 * @}  Generated on "2023-11-11 15:05:27" by the tool "gen_hq_file.py >> V20230509_1" 
 */
